/*
 * Copyright 2007-2008 Sun Microsystems, Inc.  All Rights Reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Sun designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Sun in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
 * CA 95054 USA or visit www.sun.com if you need additional information or
 * have any questions.
 */

package jsr203.nio.file.attribute;

/**
 * An object that provides a read-only or updatable view of non-opaque values
 * associated with an object in a filesystem. This interface is extended or
 * implemented by specific attribute views that define the attributes supported
 * by the view. In order to read or update an attribute value the attribute view
 * must first be {@link #bind(Object) bound} to a file system object.
 *
 * <p> In addition to reading or updating attribute values, some attribute
 * views may define methods to aid in the construction of attribute values. In
 * such cases, the attribute view may not be required to be bound to an object
 * in the file system.
 *
 * @since 1.7
 */

public interface AttributeView<T> {

    /**
     * Binds this attribute view to the given object.
     *
     * <p> An attribute view can only be bound to one object at a time;
     * invoking this method causes any previous association to be discarded.
     *
     * @param   obj
     *          The object to which attribute view should be bound, or
     *          {@code null} to discard the current association
     *
     * @return  this attribute view
     *
     * @throws  jsr203.nio.file.ProviderMismatchException
     *          If the object is associated with a provider that differs from
     *          the provider associated this attribute view
     */
    AttributeView<T> bind(T obj);
}
